Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

stripe-node v12 #1744

Merged
merged 6 commits into from
Apr 6, 2023
Merged

stripe-node v12 #1744

merged 6 commits into from
Apr 6, 2023

Conversation

richardm-stripe
Copy link
Contributor

@richardm-stripe richardm-stripe commented Apr 5, 2023

Changelog

  • #1743 Remove Stripe.default and Stripe.Stripe
    This was added to maintain backwards compatibility during the transition of stripe-node to a dual ES module / CommonJS package, and should not be functionally necessary.

  • #1742 Pin latest API version as the default
    ⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️

    In this release, Stripe API Version 2022-11-15 (the latest at time of release) will be sent by default on all requests.
    The previous default was to use your Stripe account's default API version.

    To successfully upgrade to stripe-node v12, you must either

    1. (Recommended) Upgrade your integration to be compatible with API Version 2022-11-15.

      Please read the API Changelog carefully for each API Version from 2022-11-15 back to your Stripe account's default API version. Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe Test Mode before deploying them to production.

      You can read the v12 migration guide for more detailed instructions.

    2. (Alternative option) Specify a version other than 2022-11-15 when initializing stripe-node.

      If you were previously initializing stripe-node without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your Stripe account's default API version. For example:

      - const stripe = require('stripe')('sk_test_...'); 
      + const stripe = require('stripe')('sk_test_...', {
      +   apiVersion: 'YYYY-MM-DD' // Determine your default version from https://dashboard.stripe.com/developers
      + })

      If you were already initializing stripe-node with an explicit API Version, upgrading to v12 will not affect your integration.

      Read the v12 migration guide for more details.

    Going forward, each major release of this library will be pinned by default to the latest Stripe API Version at the time of release.
    That is, instead of upgrading stripe-node and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-node, you should also upgrade your integration to be compatible with the latest Stripe API version.

@richardm-stripe richardm-stripe requested review from a team and anniel-stripe and removed request for a team April 6, 2023 20:14
Copy link
Contributor

@anniel-stripe anniel-stripe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀🚀🚀

@richardm-stripe richardm-stripe merged commit 634b7dc into master Apr 6, 2023
@richardm-stripe richardm-stripe deleted the sdk-release/next-major branch April 6, 2023 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants